home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / util / batch / GetQual130.lha / GetQual130 / GetQual.doc next >
Encoding:
Text File  |  1996-08-21  |  3.7 KB  |  117 lines
  1.                                 GetQual 1.30
  2.  
  3.                     Copyright © 1996 by Joerg Schuchardt
  4.  
  5.                                 - FREEWARE -
  6.  
  7.  
  8.  
  9. Disclaimer
  10.  
  11.     This  software (program and documentation) is provided "as is" and comes
  12.     with no warranty, either expressed or implied.
  13.     The  author  is  not  and will never be liable for any kind of damage or
  14.     loss   that   may  occur  due  to  direct  or  indirect  usage  of  this
  15.     software. You use the software on your own risk.
  16.  
  17.  
  18. Distribution
  19.  
  20.     GetQual may be freely distributed as long as all files are kept together
  21.     in  the  original  archive-file  and none of the embedded files has been
  22.     modified.
  23.  
  24.      
  25. What the program is good for
  26.  
  27.     GetQual  is  a CLI command that simply gets the state of some qualifiers
  28.     at  the  very  moment  of the program's runtime. As a result it sets the
  29.     returncode to 5 (WARN) if any qualifier is being pressed and it declares
  30.     eleven new local or global variables which can be used in a script file.
  31.     The advantage, compared to other programs which also ascertain the state
  32.     of the qualifiers, is that you only have to run the program once but can
  33.     use the result several times.
  34.       I  use  GetQual  in  the startup-sequence to influence my Amiga's con-
  35.     figuration:  start  with  or  without  loading  the EGS drivers, with or
  36.     without running the contents of the WBStartup drawer and with or without
  37.     activating additional tools.
  38.  
  39.  
  40. How to use it
  41.  
  42.     Running GetQual is as simple as it can be:
  43.     
  44.     Synopsis
  45.         GetQual [ENV] [SHOW] [CLEAR]
  46.     
  47.     Pattern
  48.         ENV/S,SHOW/S,CLEAR/S
  49.  
  50.     After  having  started  GetQual  without arguments, there are eleven new
  51.     local variables accessible, namely:
  52.     
  53.       lshift, rshift, capslock, control, lalt, ralt, lcommand, rcommand,
  54.       midbutton, rbutton and lbutton.
  55.     
  56.     The  first thing GetQual does is setting them all to "0". If a qualifier
  57.     is being pressed, the corresponding variable will be set to "1".
  58.       You  can  simply  check  the  result  by  using  GetQual with the SHOW
  59.     argument.
  60.     
  61.     If any of the qualifiers was being pressed GetQual also returns a WARN.
  62.     
  63.     Example for the startup-sequence:
  64.     
  65.       C:SetPatch QUIET
  66.       C:Version >NIL:
  67.       C:GetQual
  68.       IF WARN
  69.          C:Beep
  70.       EndIF
  71.       FailAt 21
  72.       [...]
  73.       IF $control EQ 1
  74.          C:Mount >NIL: DEVS:DOSDrivers/~(ECON|#?.info)
  75.       ELSE
  76.          C:Mount >NIL: DEVS:DOSDrivers/~(#?.info)
  77.       EndIF
  78.       [...]
  79.     
  80.     Makes  a "beep" if any qualifier was being pressed and omits loading the
  81.     EGS  drivers if <Ctrl> was the pressed qualifier. Otherwise they will be
  82.     mounted.
  83.     
  84.     Using  the argument ENV will cause GetQual to do all actions with global
  85.     variables instead of local ones.
  86.     
  87.     The  argument SHOW lists all depending variables and their values - just
  88.     as the "SET" command would do it.
  89.  
  90.     When  using  the argument CLEAR, GetQual does not get the qualifiers but
  91.     removes the variables.
  92.  
  93.  
  94. Test it
  95.  
  96.     I  have  added  a  script  file ("TestIt") that simply calls GetQual and
  97.     returns a list of the pressed qualifiers.
  98.     
  99.     Try and enjoy! ;)
  100.  
  101.  
  102. Wishes
  103.  
  104.     As  I'd like to get to know how many persons think this tool to be worth
  105.     using, I'd be glad if all users would send me a short e-mail. Thanks.
  106.     
  107.     My e-mail address is:
  108.         
  109.         ODIN@liteline.mcnet.de
  110.  
  111.  
  112. Thanks
  113.  
  114.     I wish to thank Carsten Druecke, who was a help when I became crazy of a
  115.     problem that, after all, was not caused by GetQual itself.
  116.  
  117.